Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: fetching of a secured Algolia key [BB-8083][BACKPORT] #2

Conversation

0x29a
Copy link
Member

@0x29a 0x29a commented Nov 19, 2023

Description

This is a backport of #1.

I tested the original version with Nutmeg, and it doesn't work well. There were random re-renders on opening the profile dropdown and other issues, like requests to non-existent endpoints. That's why the target branch, opencraft-release/nutmeg.2, is based on openedx@04c0ea3, which was added 11 April 2022, because 3.42.5 version of edx-enterprise was released 7 April 2022. It's worth to mention that Palm version of this MFE runs much smoother than this one.

Testing steps

Testing steps are very similar to those for #1, just replace palm with nutmeg whenever it occurs and use 0x29a/bb8083/per-user-algolia-key-nutmeg instead of 0x29a/bb8083/per-user-algolia-key branches.

Also keep in mind these pitfalls:

  1. Unlike Palm, Nutmeg devstack doesn't start Redis automatically. Additionally to make dev.up.large-and-slow, you'll have to run make dev.up.redis.
  2. There is no CONTENT_PRODUCT_SOURCE_ALLOW_LIST in enterprise_catalog/apps/catalog/constants.py. You can skip this and other source-related steps.
  3. Provisioning of enterprise-catalog may fail due to an ensurepip issue. In this case, edit Dockerfile to install python3-venv (there is python3.8-venv, but it doesn't work for some reason).
  4. MySQL for enterprise-catalog may be crashing during provisioning. If you experience this, add the following change to docker-compose.yml:
     services:
       mysql:
         image: mysql:5.7
    +    command: ["mysqld", "--character-set-server=utf8mb3", "--collation-server=utf8mb3_general_ci"]
         container_name: enterprise.catalog.mysql
         environment:
           MYSQL_ROOT_PASSWORD: ""
           MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
           MYSQL_DATABASE: "enterprise_catalog"   

@0x29a 0x29a changed the title feat: fetching of a secured Algolia key [BB-8083] feat: fetching of a secured Algolia key [BB-8083][BACKPORT] Nov 19, 2023
Copy link
Member

@Agrendalath Agrendalath left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

  • I tested this: compared the diff to the original PR; it's not a clean backport, but looks good
  • I read through the code
  • I checked for accessibility issues: n/a
  • Includes documentation: n/a
  • I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository: n/a

@Agrendalath Agrendalath merged commit f57e9e6 into opencraft-release/nutmeg.2 Nov 21, 2023
@Agrendalath Agrendalath deleted the 0x29a/bb8083/per-user-algolia-key-nutmeg branch November 21, 2023 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants